Add first set of `profile` commands #2917

MatteoPologruto · 2025-05-21T15:39:24Z

Please check if the PR fulfills these requirements

See how to contribute

The PR has no duplicates (please search among the Pull Requests
before creating one)
The PR follows
our contributing guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
UPGRADING.md has been updated with a migration guide (for breaking changes)
configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Code enhancement

What is the current behavior?

Operations on the sketch.yaml project file must be done manually.

What is the new behavior?

First set of profile commands:

profile create -m <PROFILE_NAME -b <FQBN> [--set-default] [<SKETCH_PATH>] adds a profile to the sketch. If sketch.yaml does not exist, it is created. By default, it creates the profile in the sketch in the current directory. The new profile will have the specified name and FQBN (both mandatory). The platform is detected automatically. If the flag --set-default is set, the new profile will be set as the default. The command fails in the following cases:
- The SKETCH_PATH does not exist, or the sketch is invalid.
- The FQBN is wrong, or the platform related to it is not installed locally.
profile lib add <LIB_NAME[@LIB_VERSION]> [-m <PROFILE_NAME>] [--sketch-path <SKETCH_PATH>] [--no-deps] [--no-overwrite] adds a library to the provided profile or to the default one. By default, it checks the sketch in the current directory. If --no-deps []). If --no-overwrite is set, the libraries already present in the profile will be left untouched even if they could be upgraded.
profile lib remove <LIB_NAME> [-m <PROFILE_NAME>] [--sketch-path <SKETCH_PATH>] [--no-deps] removes a library and its dependencies (if no longer needed) from the provided profile or from the default one. By default, it checks the sketch in the current directory. If --no-deps is set, only the given library is removed (ignoring the dependencies).
profile set-default <PROFILE_NAME> [--sketch-path <SKETCH_PATH>] sets the default profile to the specified profile. By default, it checks the sketch in the current directory.

Does this PR introduce a breaking change, and is titled accordingly?

No

Other information

codecov · 2025-05-21T15:53:30Z

Codecov Report

❌ Patch coverage is 81.22744% with 52 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.49%. Comparing base (a9538d1) to head (290e0e1).
⚠️ Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
commands/service_profile_create.go	72.50%	6 Missing and 5 partials ⚠️
internal/cli/arguments/completion.go	0.00%	11 Missing ⚠️
internal/cli/profile/profile_lib_remove.go	83.05%	9 Missing and 1 partial ⚠️
internal/cli/feedback/result/rpc.go	55.00%	9 Missing ⚠️
internal/cli/profile/profile_lib_add.go	86.36%	7 Missing and 2 partials ⚠️
internal/cli/profile/profile_create.go	94.87%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2917      +/-   ##
==========================================
+ Coverage   69.17%   69.49%   +0.31%     
==========================================
  Files         247      253       +6     
  Lines       18926    19160     +234     
==========================================
+ Hits        13093    13316     +223     
- Misses       4601     4613      +12     
+ Partials     1232     1231       -1

Flag	Coverage Δ
unit	`69.49% <81.22%> (+0.31%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

kittaakos · 2025-05-27T14:40:25Z

Hello, this is great 🔥 Maybe you want to consider adding and removing multiple libs (later cores) with a single request. I do not know how it performs, but when a user interface wants to initialize a profile from a set of libraries and cores, one request would be better than multiple ones.

Update: I checked the changes only from the point of the proto API as a client.

alessio-perugini

Great job! 🚀

We have a bug in the long standing:

arduino-cli/internal/arduino/sketch/profiles.go

Lines 166 to 167 in 55f86b5

    
           res += p.Platforms.AsYaml() 
        
           res += p.Libraries.AsYaml()

arduino-cli profile init --profile Uno_profile -b arduino:avr:uno /tmp/sk

cat /tmp/sk/sketch.yaml

profiles:
  Uno_profile:
    fqbn: arduino:avr:uno
    platforms:
      - platform: arduino:avr (1.8.6)
    libraries:

default_profile: c

You can see here that it produces libraries: without [], this is an invalid yaml.

Basically we have to check if the items == 0, then we either skip that property or we set libraries: [].
I'm afraid it could also happen for the platforms so I'd put that check there too.

commands/cmderrors/cmderrors.go

rpc/cc/arduino/cli/commands/v1/commands.proto

commands/service_profile_dump.go

alessio-perugini · 2025-05-28T14:00:49Z

commands/service_profile_init.go

+		}
+
+		newProfile := &sketch.Profile{Name: req.GetProfileName(), FQBN: req.GetFqbn()}
+		// TODO: what to do with the PlatformIndexURL?


Do we have some kind of internal API that we can use to retrieve platform <-> index URL?

cc: @cmaglie

internal/cli/profile/init.go

internal/cli/profile/profile_set-default.go

commands/service_profile_init.go

internal/integrationtest/profiles/profiles_test.go

per1234

I feel that the design of the profile dump command is inappropriate. This command is actually printing the data of the entire sketch project file, not the build profile data alone. Although the primary usage of the sketch project file is currently for defining build profiles, it is not limited to this purpose and there is a good chance that it will be used for additional things unrelated to build profiles as time goes on.

The profile dump command should be a tool for printing the data from a build profile.

If you want a tool for printing the sketch project file, that should go somewhere else, such as under the sketch command (e.g., sketch project dump), not under the profile command.

If the user doesn't specify a profile ID, it should print the default build profile from the sketch project file. An --all flag could be added to cause it to print all build profiles present in the sketch project file.

internal/cli/profile/dump.go

internal/cli/profile/init.go

internal/cli/profile/lib.go

internal/cli/profile/profile.go

internal/cli/profile/set_default.go

rpc/cc/arduino/cli/commands/v1/commands.proto

internal/cli/profile/lib.go

commands/service_profile_lib_add.go

cmaglie · 2025-12-04T15:34:57Z

I'm going to rebase this one on top of #3019.

cmaglie · 2025-12-05T17:13:34Z

Removed profile dump command.
Renamed profile init -> profile create.
profile create will create the sketch.yaml only if a new profile is added.
Improved help and terminology consistency,
Renamed --dest-dir -> --sketch-path.
Library dependencies are now beautifully managed thanks to Added gRPC functions to manage libraries in profiles #3019!
Fixed bash autocompletion for profile lib remove Ardu.... (it will display the libraries present in the selected profile!).

MatteoPologruto self-assigned this May 21, 2025

MatteoPologruto added type: enhancement Proposed improvement topic: code Related to content of the project itself labels May 21, 2025

MatteoPologruto linked an issue May 21, 2025 that may be closed by this pull request

Add first set of profile commands #2916

Open

3 tasks

MatteoPologruto changed the title ~~Add first set of profile command~~ Add first set of profile commands May 21, 2025

MatteoPologruto force-pushed the add-profiles-command-support branch 5 times, most recently from 896841b to a2c86ef Compare May 23, 2025 15:21

MatteoPologruto marked this pull request as ready for review May 27, 2025 14:08

MatteoPologruto requested review from a team and cmaglie May 27, 2025 14:08

alessio-perugini suggested changes May 28, 2025

View reviewed changes

per1234 requested changes May 29, 2025

View reviewed changes

MatteoPologruto force-pushed the add-profiles-command-support branch from d92be42 to 5381938 Compare May 30, 2025 14:17

lucarin91 reviewed Jun 13, 2025

View reviewed changes

commands/service_profile_lib_add.go Outdated Show resolved Hide resolved

per1234 mentioned this pull request Jun 16, 2025

Automatically install library dependencies for libraries in sketch profile #2934

Closed

3 tasks

MatteoPologruto force-pushed the add-profiles-command-support branch from 5381938 to 3cd499a Compare September 26, 2025 15:44

cmaglie force-pushed the add-profiles-command-support branch 6 times, most recently from 830a052 to 65354c4 Compare October 3, 2025 01:07

cmaglie mentioned this pull request Oct 3, 2025

Added gRPC functions to manage libraries in profiles #3019

Merged

6 tasks

Improved handling of ProfileLibraryReference results

c537b5a

cmaglie added 4 commits December 5, 2025 15:15

Implementation of profile commands

80b0018

Improved some help description

08708b9

Moved args into their correct place

82c627a

Added remove deps

861d877

cmaglie force-pushed the add-profiles-command-support branch from 65354c4 to 8f10864 Compare December 5, 2025 15:01

cmaglie added 2 commits December 5, 2025 16:01

Fixed completion in profile lib remove

d432466

Rename 'profile init' -> 'profile create'

99c8c88

cmaglie force-pushed the add-profiles-command-support branch from 8f10864 to aa47bd5 Compare December 5, 2025 15:10

cmaglie added 2 commits December 5, 2025 16:13

Proper behaviour for 'profile create' command

a929e02

Added profile management integration tests

71b0902

cmaglie force-pushed the add-profiles-command-support branch from aa47bd5 to 71b0902 Compare December 5, 2025 16:43

Rename --dest-dir to --sketch-path

290e0e1

Uh oh!

Add first set of profile commands #2917

Are you sure you want to change the base?

Add first set of profile commands #2917

Conversation

MatteoPologruto commented May 21, 2025 • edited by cmaglie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please check if the PR fulfills these requirements

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change, and is titled accordingly?

Other information

Uh oh!

codecov bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kittaakos commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alessio-perugini left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alessio-perugini May 28, 2025

Choose a reason for hiding this comment

Uh oh!

alessio-perugini May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

per1234 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cmaglie commented Dec 4, 2025

Uh oh!

cmaglie commented Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add first set of `profile` commands #2917

Add first set of `profile` commands #2917

MatteoPologruto commented May 21, 2025 •

edited by cmaglie

Loading

codecov bot commented May 21, 2025 •

edited

Loading

kittaakos commented May 27, 2025 •

edited

Loading

alessio-perugini left a comment •

edited

Loading

per1234 left a comment •

edited

Loading